<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Whm_Functions_SSL</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Whm_Functions_SSL</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">WHM SSL Functions</p>
<p class="description"><p>Calls to SSL functions of the WHM XML and JSON APIs</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Peter Kumaschow</li>
				<li><span class="field">copyright:</span> Peter Kumaschow 2011</li>
				<li><span class="field">link:</span> <a href="http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi">http://docs.cpanel.net/twiki/bin/view/SoftwareDevelopmentKit/XmlApi</a></li>
				<li><span class="field">license:</span> GNU</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Functions---SSL.php.html">/Functions/SSL.php</a> (line <span class="field">34</span>)
		</p>
		
				
		<pre><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a>
   |
   --Whm_Functions_SSL</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																				
												<div class="method-definition">
											<span class="method-result">object</span>
										<a href="#fetchsslinfo" title="details" class="method-name">fetchsslinfo</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$crtdata</span> = <span class="var-default">NULL</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#generatessl" title="details" class="method-name">generatessl</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
										<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_apiresponse">Whm_Functions_Abstract::$_apiresponse</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_method">Whm_Functions_Abstract::$_method</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_params">Whm_Functions_Abstract::$_params</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_querystring">Whm_Functions_Abstract::$_querystring</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#var$_rest">Whm_Functions_Abstract::$_rest</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodfetchsslinfo" id="fetchsslinfo"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">fetchsslinfo</span> (line <span class="line-number">48</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the SSL certificate, private key, and CA bundle/intermediate  certificate associated with a specified domain.</p>
<p class="description"><p>Alternatively, it can display the private key and CA bundle associated  with a specified SSL certificate.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object</span>
		<span class="method-name">
			fetchsslinfo
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$crtdata</span> = <span class="var-default">NULL</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$domain</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$crtdata</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgeneratessl" id="generatessl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">generatessl</span> (line <span class="line-number">73</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates an SSL certificate.</p>
<p class="description"><p>Valid parameters</p><p>xemail (string) — Email address of the domain owner.  host (string) — Domain the SSL certificate will be associated with.  country (string) — Country in which your organization is located.  state (string) — State in which your organization is located.  city (string) — City in which your organization is located.  co (string) — Organization name.  cod (string) — Department name associated with the SSL certificate.  email (string) — Email address to which the certificate will be sent.  pass (string) — Password associated with the SSL certificate.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			generatessl
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html">Whm_Functions_Abstract</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#method__construct">Whm_Functions_Abstract::__construct()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodapplist">Whm_Functions_Abstract::applist()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodcheckParams">Whm_Functions_Abstract::checkParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methoddecode">Whm_Functions_Abstract::decode()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetApi">Whm_Functions_Abstract::getApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetMethod">Whm_Functions_Abstract::getMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetParams">Whm_Functions_Abstract::getParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodgetQueryString">Whm_Functions_Abstract::getQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodpost">Whm_Functions_Abstract::post()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodquickpost">Whm_Functions_Abstract::quickpost()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetApi">Whm_Functions_Abstract::setApi()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetMethod">Whm_Functions_Abstract::setMethod()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetParams">Whm_Functions_Abstract::setParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodsetQueryString">Whm_Functions_Abstract::setQueryString()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodvalidateParams">Whm_Functions_Abstract::validateParams()</a></span><br>
													<span class="method-name"><a href="../../whm-lib/Functions/Whm_Functions_Abstract.html#methodversion">Whm_Functions_Abstract::version()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 06 Nov 2011 23:33:12 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>